-
Notifications
You must be signed in to change notification settings - Fork 3
feat: rename accounts to data in list external accounts response #127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: rename accounts to data in list external accounts response #127
Conversation
Greptile OverviewGreptile SummaryThis PR standardizes the response format for the Key changes:
Breaking change consideration: Confidence Score: 4/5
|
| Filename | Overview |
|---|---|
| openapi/paths/platform/platform_external_accounts.yaml | Renamed response property from accounts to data in GET endpoint to match API standards |
| openapi.yaml | Generated bundle file updated with the data property change from source files |
| mintlify/openapi.yaml | Generated bundle file updated with the data property change for Mintlify docs |
Sequence Diagram
sequenceDiagram
participant Client
participant API as Grid API
participant Schema as OpenAPI Schema
Note over Client,Schema: Before Change (Inconsistent)
Client->>API: GET /platform/external-accounts
API->>Schema: Validate response schema
Note over Schema: Response uses "accounts" property
Schema-->>API: Schema validation
API-->>Client: { "accounts": [...] }
Note over Client: Inconsistent with other endpoints
Note over Client,Schema: After Change (Consistent)
Client->>API: GET /platform/external-accounts
API->>Schema: Validate response schema
Note over Schema: Response uses "data" property
Schema-->>API: Schema validation
API-->>Client: { "data": [...] }
Note over Client: Now consistent with all other list endpoints
7ff24cf to
b515799
Compare
836aded to
b4541c7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
b515799 to
e11522c
Compare
b4541c7 to
fc8dd03
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The base branch was changed.
e11522c to
1ccf581
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.

TL;DR
Updated the response schema for external accounts endpoint to use
datainstead ofaccountsas the property name.What changed?
Changed the required property name in the external accounts API response from
accountstodata. This affects the schema definition in the OpenAPI specification across multiple files:mintlify/openapi.yamlopenapi.yamlopenapi/paths/platform/platform_external_accounts.yamlHow to test?
dataarray instead of anaccountsarrayWhy make this change?
This change standardizes the API response format to be consistent with other endpoints in the system that use
dataas the top-level property for array responses. This improves API consistency and makes client integration more predictable.